Cause<'error>Union

PackageAxial
Represents the cause of a failed workflow.

Specification

Kind
Union
Members
12
Examples
0
IsInterruptSignature
this.IsInterrupt
IsFailSignature
this.IsFail
IsTracedSignature
this.IsTraced
IsBothSignature
this.IsBoth
IsDieSignature
this.IsDie

Summary

NameSignatureSynopsis
IsInterruptthis.IsInterruptNo description available.
IsFailthis.IsFailNo description available.
IsTracedthis.IsTracedNo description available.
IsBoththis.IsBothNo description available.
IsDiethis.IsDieNo description available.
IsThenthis.IsThenNo description available.
FailFail 'errorAn expected domain-specific failure.
DieDie exnAn unexpected defect or panic (e.g., an exception).
InterruptInterruptAn administrative signal to stop the workflow (e.g., cancellation).
ThenThen(Cause<'error>, Cause<'error>)Two causes happened sequentially; the left cause happened before the right cause.
BothBoth(Cause<'error>, Cause<'error>)Two causes happened concurrently; neither cause is ordered before the other.
TracedTraced(Cause<'error>, trace)A cause annotated with diagnostic trace text.

IsInterrupt

this.IsInterrupt
Member

Returns

bool

IsFail

this.IsFail
Member

Returns

bool

IsTraced

this.IsTraced
Member

Returns

bool

IsBoth

this.IsBoth
Member

Returns

bool

IsDie

this.IsDie
Member

Returns

bool

IsThen

this.IsThen
Member

Returns

bool

Fail

Fail 'error
Member
An expected domain-specific failure.

Parameters

NameTypeDescription
Item'error

Returns

unit

Die

Die exn
Member
An unexpected defect or panic (e.g., an exception).

Parameters

NameTypeDescription
Itemexn

Returns

unit

Interrupt

Interrupt
Member
An administrative signal to stop the workflow (e.g., cancellation).

Returns

unit

Then

Then(Cause<'error>, Cause<'error>)
Member
Two causes happened sequentially; the left cause happened before the right cause.

Parameters

NameTypeDescription
Item1Cause<'error>
Item2Cause<'error>

Returns

unit

Both

Both(Cause<'error>, Cause<'error>)
Member
Two causes happened concurrently; neither cause is ordered before the other.

Parameters

NameTypeDescription
Item1Cause<'error>
Item2Cause<'error>

Returns

unit

Traced

Traced(Cause<'error>, trace)
Member
A cause annotated with diagnostic trace text.

Parameters

NameTypeDescription
Item1Cause<'error>
tracestring

Returns

unit